home *** CD-ROM | disk | FTP | other *** search
/ PC World Komputer 2010 April / PCWorld0410.iso / hity wydania / Ubuntu 9.10 PL / karmelkowy-koliberek-desktop-9.10-i386-PL.iso / casper / filesystem.squashfs / usr / lib / perl5 / Glib / Flags.pod < prev    next >
Text File  |  2009-04-29  |  2KB  |  176 lines
  1. =head1 NAME
  2.  
  3. Glib::Flags -  Overloaded operators representing GLib flags
  4.  
  5. =cut
  6.  
  7. =head1 HIERARCHY
  8.  
  9.   Glib::Flags
  10.  
  11.  
  12.  
  13. =cut
  14.  
  15. =for object Glib::Flags Overloaded operators representing GLib flags
  16.  
  17. =for position DESCRIPTION
  18.  
  19. =head1 DESCRIPTION
  20.  
  21. Glib maps flag and enum values to the nicknames strings provided by the
  22. underlying C libraries.  Representing flags this way in Perl is an interesting
  23. problem, which Glib solves by using some cool overloaded operators. 
  24.  
  25. The functions described here actually do the work of those overloaded
  26. operators.  See the description of the flags operators in the "This Is
  27. Now That" section of L<Glib> for more info.
  28.  
  29. =cut
  30.  
  31.  
  32.  
  33.  
  34. =head1 METHODS
  35.  
  36. =head2 scalar = $class-E<gt>B<new> ($a)
  37.  
  38. =over
  39.  
  40. =item * $a (scalar) 
  41.  
  42. =back
  43.  
  44. Create a new flags object with given bits.  This is for use from a
  45. subclass, it's not possible to create a C<Glib::Flags> object as such.
  46. For example,
  47.  
  48.     my $f1 = Glib::ParamFlags->new ('readable');
  49.     my $f2 = Glib::ParamFlags->new (['readable','writable']);
  50.  
  51. An object like this can then be used with the overloaded operators.
  52.  
  53. =head2 scalar = $a-E<gt>B<all> ($b, $swap)
  54.  
  55. =over
  56.  
  57. =item * $b (scalar) 
  58.  
  59. =item * $swap (scalar) 
  60.  
  61. =back
  62.  
  63. =head2 ref = $a->B<as_arrayref>
  64.  
  65. =over
  66.  
  67. =back
  68.  
  69.  
  70.  
  71. =head2 integer = $a-E<gt>B<bool> ($b, $swap)
  72.  
  73. =over
  74.  
  75. =item * $b (scalar) 
  76.  
  77. =item * $swap (integer) 
  78.  
  79. =back
  80.  
  81.  
  82.  
  83. =head2 integer = $a-E<gt>B<eq> ($b, $swap)
  84.  
  85. =over
  86.  
  87. =item * $b (scalar) 
  88.  
  89. =item * $swap (integer) 
  90.  
  91. =back
  92.  
  93. =head2 integer = $a-E<gt>B<ge> ($b, $swap)
  94.  
  95. =over
  96.  
  97. =item * $b (scalar) 
  98.  
  99. =item * $swap (integer) 
  100.  
  101. =back
  102.  
  103. =head2 scalar = $a-E<gt>B<intersect> ($b, $swap)
  104.  
  105. =over
  106.  
  107. =item * $b (scalar) 
  108.  
  109. =item * $swap (scalar) 
  110.  
  111. =back
  112.  
  113. =head2 integer = $a-E<gt>B<ne> ($b, $swap)
  114.  
  115. =over
  116.  
  117. =item * $b (scalar) 
  118.  
  119. =item * $swap (integer) 
  120.  
  121. =back
  122.  
  123. =head2 scalar = $a-E<gt>B<sub> ($b, $swap)
  124.  
  125. =over
  126.  
  127. =item * $b (scalar) 
  128.  
  129. =item * $swap (scalar) 
  130.  
  131. =back
  132.  
  133. =head2 scalar = $a-E<gt>B<union> ($b, $swap)
  134.  
  135. =over
  136.  
  137. =item * $b (scalar) 
  138.  
  139. =item * $swap (scalar) 
  140.  
  141. =back
  142.  
  143. =head2 scalar = $a-E<gt>B<xor> ($b, $swap)
  144.  
  145. =over
  146.  
  147. =item * $b (scalar) 
  148.  
  149. =item * $swap (scalar) 
  150.  
  151. =back
  152.  
  153.  
  154.  
  155. =cut
  156.  
  157.  
  158. =head1 SEE ALSO
  159.  
  160. L<Glib>
  161.  
  162.  
  163. =cut
  164.  
  165.  
  166. =head1 COPYRIGHT
  167.  
  168. Copyright (C) 2003-2009 by the gtk2-perl team.
  169.  
  170. This software is licensed under the LGPL.  See L<Glib> for a full notice.
  171.  
  172.  
  173.  
  174. =cut
  175.  
  176.